RCS-SMS Fallback Request
In this use case, enterprise wants to first attempt the RCS, if failed DLR is received from the channel, SMS will be triggered. DLR for both the messages will be pushed to Enterprise webhook URL.
Note: Enterprise needs to be onboarded for all the channels before sending this request.
S.No. | Attribute | Required | Data Type | Details |
---|---|---|---|---|
3.1. | template_message | Yes | Object | Specifying the message object as Template message |
3.1.1. | channel_template | Yes | Object | Contains the channel and template details |
3.1.1.1. | RCS | Yes | Object | Specifying the channel |
3.1.1.1.1. | template_id | Yes | String | Template identification |
3.1.1.1.2. | language_code | Yes | String | The BCP-47 language code, such as en-US or sr-Latn. English is the default language_code. |
3.1.1.1.3. | parameters | No | Object | Required if the template has variables. Concrete values must be present for all defined parameters in the template. |
3.2. | explicit_channel_message | Yes | Object | For specifying SMS message |
3.2.1. | SMS | Yes | String | All the information required to send the SMS text including user ID, password, sender ID, recipient, complete text, etc. Details of all the required fields are mentioned in the table below. |
Details of the fields required to send SMS text message below.
S.No. | Parameter | Parameter Description | Criteria* |
---|---|---|---|
1 | userid | User Id provided by Sinch India to an enterprise for authentication | M |
2 | pass | Password provided by Sinch India for authentication of User Id | M |
3 | appid | Application Id associated with an enterprise, provided by Sinch India | M |
4 | subappid | If Enterprise has subdivisions, then provided by Sinch India for a particular division | O |
5 | msgid | It should be unique id for every request, generated by enterprise. | M |
6 | id | This is a unique id provided if the request has multiple mobile numbers. If not provided, it is added by the platform as an incremental value. | O |
7 | msisdn | The Mobile number(s) where SMS to be sent. For more than one Mobile number, comma used as a separator. E.g. 9810790950,9810549171 | M |
8 | from | Sender id to be sent with the SMS | M |
9 | content-type | "1" for text SMS. Details as mentioned below | M |
10 | selfid | It should be set “true”, Sinch India platform maps a message id along with the request | M |
11 | text | Message Text | M |
12 | auth | These are dummy fields, with max allowed length as 50. If not provided, app id is passed | O |
13 | subauth | These are dummy fields, with max allowed length as 50. If not provided, subapp id is passed | O |
14 | brd | The campaign name with the max allowed limit as 50. If not provided, the systems allocate the name. | O |
15 | dpi | DLT principal entity ID | O |
16 | dtm | DLT template ID | O |
17 | tc | Template category: Transactional (1), Promotional (2), Service Implicit (3), Service Explicit (4) | O |
18 | intflag | The identifier for domestic and international traffic | O |
19 | alert | To be set either 0 or 1, by default its value will be 0 means request will pass through DND Check. | O |
20 | language | The language parameter is used to convert English message with whitelisted template to be delivered in a regional language. The regional language template needs to be pre-configured with us. The specific language to be used is mentioned in the language table. | O |
21 | shorten | Flag to invoke URL shortening. Please contact the service operations team for enabling URL shortening for your account. - 0 to disable shortening for the request - 1 to enable shortening for the request Invalid values return negative response code | O |
22 | domain | The parameter to define a custom short domain to be used. Should match one of the pre-configured values. Contact service operations for configuration. | O |
23 | p | The parameter to invoke and define the alias or description to be added in the short URL created. Helps make the short URL relevant to the message request or landing page. Improves conversion rate. - 1-30 characters - Allowed: a-z, A-Z, 0-9, -, _, ., (, ) | O |
24 | forward | Flag to request click forwarding in real-time to a pre-configured web-service URL. Contact service operations for configuration. Supported parameters are defined later. - 0 to disable forwarding for the request - 1 to enable forwarding for the request Invalid values return negative response code. | O |
25 | dr | Flag to request placeholder replacement with App URLs in real-time. Allows OS-specific dynamic redirection to different destinations for iOS, Android, or other devices. Contact service operations for enabling dynamic redirection. - 0 to disable dynamic redirection for the request - 1 to enable dynamic redirection for the request Invalid values return negative response code. Default App URL insertion can be set up by contacting Service Operations. | O |
26 | iu | Parameter to define iOS destination URL for redirecting users clicking an App URL from iOS devices. Should be a valid HTTP URL with protocol prefix http:// or https:// . Default values can be configured if specific destinations are not provided in each request. | O |
27 | au | Parameter to define Android destination URL for redirecting users clicking an App URL from Android devices. Should be a valid HTTP URL with protocol prefix http:// or https:// . Default values can be configured if specific destinations are not provided in each request. | O |
28 | fb | Parameter to define Fallback or default destination URL for redirecting users clicking an App URL from other OS devices. Should be a valid HTTP URL with protocol prefix http:// or https:// . Mandatory if dr is set and default destinations are not configured. | M (if dr is set and default destinations are not configured) * M=Mandatory, O=Optional |
{
"app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
"recipient": {
"identified_by": {
"channel_identities": [
{
"channel": "RCS",
"identity": "919876543210"
},
{
"channel": "SMS",
"identity": "919876543210"
}
]
}
},
"message": {
"explicit_channel_message": {
"SMS": "{\"userId\":\"sindsasms\",\"pass\":\"sincdjh_5\",\"from\":\"ACLTST\",\"selfid\":\"true\",
\"contenttype\":\"1\",\"to\":\"919876543210\",\"text\":\"HiShubhamgreetingsfromACL.\",\"alert\":\"1
\"}"
},
"template_message": {
"channel_template": {
"RCS": {
"template_id": "test_rich_carousel",
"language_code": "en",
"parameters": {
"amount": "INR 500",
"discount": "20%",
}
}
}
}
},
"channel_priority_order": [
"RCS",
"SMS"
]
}